Documentación de Customers

NAV Navigation

CustomersApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Email: Iberinform Web: Iberinform

Authentication

  • API Key (ClientSecretHeader)

    • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
  • API Key (APIKeyHeader)

    • Parameter Name: X-IBM-Client-Id, in: header.

Default

get__customers_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/customers/{organisationID}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(

 new InputStreamReader(con.getInputStream()));

String inputLine;

StringBuffer response = new StringBuffer();

while ((inputLine = in.readLine()) != null) {

 response.append(inputLine);

}

in.close();

System.out.println(response.toString());




const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/customers/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});


GET https://$(catalog.host)/modules/customers/{organisationID} HTTP/1.1


Accept: application/json


 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY',

);


$client = new \GuzzleHttp\Client();


// Define array of request body.

$request_body = array();


try {

 $response = $client->request('GET','https://$(catalog.host)/modules/customers/{organisationID}', array(

 'headers' => $headers,

 'json' => $request_body,

 )

 );

 print_r($response->getBody()->getContents());

 }

 catch (\GuzzleHttp\Exception\BadResponseException $e) {

 // handle exception or api errors.

 print_r($e->getMessage());

 }


 // ...


import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/customers/{organisationID}', headers = headers)


print(r.json())


require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/customers/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)


# You can also use wget

curl -X GET https://$(catalog.host)/modules/customers/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'



GET /customers/{organisationID}

Parameters

Name In Type Required Description
organisationID path string true identificador de la firma
language query string false Idioma generación

Example responses

401 Response

"{"code":"string","message":"string","principal":"string","status":0}"


Responses

Status Meaning Description Schema
200 OK 200 OK None
401 Unauthorized Unauthorized ErrorDetail
403 Forbidden Forbidden ErrorDetail
404 Not Found Recurso no encontrado ErrorDetail
500 Internal Server Error Internal error ErrorDetail

Schemas

ErrorDetail

"{"code":"string","message":"string","principal":"string","status":0}"



Properties

Name Type Required Restrictions Description
code string false none none
message string false none none
principal string false none none
status number false none none

CustoDetail

"{"activityScope":{"code":"string","value":"string"},"averageCollectionTime":{"code":"string","value":"string"},"customerPortfolio":{"code":"string","value":"string"},"customerType":{"dataSource":{"date":"string","source":"string"},"items":[{"code":"string","value":"string"}],"unavailabilityReason":"string"},"distributionChannels":{"dataSource":{"date":"string","source":"string"},"items":[{"code":"string","value":"string"}],"unavailabilityReason":"string"},"export":"string","exportCountries":{"dataSource":{"date":"string","source":"string"},"items":[{"code":"string","value":"string"}],"unavailabilityReason":"string"},"lastYearExportPercentage":"string","notAvailable":"string"}"



Properties

Name Type Required Restrictions Description
activityScope object false none none
  code string false none none
  value string false none none
averageCollectionTime object false none none
  code string false none none
  value string false none none
customerPortfolio object false none none
  code string false none none
  value string false none none
customerType object false none none
  dataSource object false none none
   date string false none none
   source string false none none
  items [object] false none none
   code string false none none
   value string false none none
  unavailabilityReason string false none none
distributionChannels object false none none
  dataSource object false none none
   date string false none none
   source string false none none
  items [object] false none none
   code string false none none
   value string false none none
  unavailabilityReason string false none none
export string false none none
exportCountries object false none none
  dataSource object false none none
   date string false none none
   source string false none none
  items [object] false none none
   code string false none none
   value string false none none
  unavailabilityReason string false none none
lastYearExportPercentage string false none none
notAvailable string false none none